home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfgiltrv.zip / SFGILTRV.DOC < prev    next >
Text File  |  1991-09-14  |  20KB  |  460 lines
  1.  
  2.                                SFGILTRV
  3.                   SPITFIRE GILLIGANS ISLAND TRIVIA DOOR
  4.                                    By
  5.                                 Jim Slade
  6.  
  7.  
  8.     
  9.    INTRODUCTION
  10.    ------------
  11.                          
  12.       SFGILTRV is a fast paced Gilligan's island trivia game designed to run
  13.    as a door feature within the SPITFIRE Bulletin Board System.  It can
  14.    also be installed as a sysop configurable command from the Main, File
  15.    or Message menus of SPITFIRE.  A data file containing over 100 Gilligan's
  16.    Island trivia questions is randomly accessed and displayed to the screen.
  17.    With each question that is displayed, four multiple choice options 
  18.    are provided from which the player may select.  SFGILTRV allows the
  19.    Sysop to configure the delay time (defaults to ten seconds) that the
  20.    player is allowed to read the question and respond with the number 
  21.    corresponding to the answer they wish to select.
  22.     
  23.     
  24.    SFGILTRV COMMAND LINE PARAMETERS
  25.    -------------------------------
  26.    
  27.       /P - Designates the drive, path, filename and extension of the
  28.            high score bulletin to be used with SFGILTRV
  29.  
  30.       /D - Designates the delay time (in seconds) that the user is
  31.            allowed to answer the question before it "times out".      
  32.  
  33.       /L - Allows local usage of SFGILTRV
  34.  
  35.  
  36.       The /P command line parameter is available which will automatically
  37.    create Ansi and Non-Ansi high score bulletins for your BBS system.  
  38.    If you would like to use this option, a "/P" should follow the 
  39.    SFGILTRV in the command line to indicate a valid DOS path where the
  40.    bulletin file will be created.   (NOTE:  This should be the same
  41.    as the display file path you have set up within SPITFIRE.)  The path 
  42.    is then followed by the file name of the bulletin to be created.  It 
  43.    is not necessary to include the file extension.  SFGILTRV will
  44.    automatically add a .BBS extension for the Non-Ansi display file and 
  45.    a .CLR extension for the Ansi display file created.  The correct 
  46.    syntax should look like this:
  47.    
  48.    SFGILTRV /P C:\SF\DISPLAY\DORBUL1
  49.    
  50.    The "/P" command line is optional and SFGILTRV will operate perfectly
  51.    fine without it.  However, it is a convenient means of providing and 
  52.    posting high score bulletins for the Gilligan's trivia door.
  53.  
  54.  
  55.      The /D command line parameter is also available which will allow the
  56.    Sysop to designate the delay time (in seconds) that is allowed between
  57.    the time the question prompt is displayed to the screen and when the
  58.    user must enter the desired answer.  This is done using the /Dnn (where
  59.    nn represents the number of seconds) command line parameter.  As an
  60.    example, if the Sysop wishes to allow a 15 second delay, a /D15 would
  61.    be entered on the command line as illustrated below:
  62.    
  63.    SFGILTRV /D15
  64.  
  65.    If no /Dnn is designated at the command line, SFGILTRV will default to
  66.    a ten second delay.
  67.  
  68.  
  69.       The /L command line parameter will allow SFGILTRV to be played
  70.    locally without requiring a SFDOORS.DAT, SFMAIN.DAT, SFMESS.DAT or
  71.    SFFILE.DAT file.  Using the /L command line parameter disables the
  72.    program's carrier detect monitoring and redirection of the game
  73.    through the comm port.  For local operation of SFGILTRV enter the
  74.    following command at the DOS prompt:
  75.    
  76.    C:> SFGILTRV /L
  77.     
  78.     ** SPECIAL NOTE **  The /L, /P and /D command parameters can be
  79.     used together in one command line to specify the drive, path and
  80.     filename of the bulletin to be created and the delay time in seconds
  81.     when playing in local mode.
  82.  
  83.    It should also be noted that the /P, /D and /L command line parameters
  84.    may appear in any order on the command line.  SFGILTRV does NOT require
  85.    these to be used in a specific order.
  86.  
  87.  
  88.  
  89.    SFGILTRV SETUP AS A SPITFIRE DOOR
  90.    ---------------------------------
  91.     
  92.       To set up SFGILTRV to be executed as a door, it is recommended that
  93.    a separate directory be set up for it.  For explanation purposes, let's
  94.    assume the directory DOORA is created for use with SFGILTRV.  The following
  95.    files must then be placed in the directory:
  96.    
  97.    SFGILTRV.EXE    The actual game program.
  98.    
  99.    SFGILTRV.DAT    The data file containing the trivia questions.
  100.    
  101.    SFGILTRV.TOP    This is a listing of the top ten players.  SFGILTRV.EXE
  102.                    will create this file if it is not found. 
  103.                    
  104.    SFGILTRV.LMT    This allows you to set time limits according to the
  105.                    callers security level.
  106.    
  107.    The Sysop will then need to use a text editor to edit the SF.BAT file   
  108.    as illustrated below:
  109.    
  110.    :DOOR_A
  111.    COPY SFDOORS.DAT C:\SF\DOORA
  112.    SFGILTRV
  113.    ERASE SFDOORS.DAT
  114.    GOTO LOOP
  115.    :DOOR_B
  116.      
  117.  
  118.    You will notice that the commands needed to execute SFGILTRV are placed
  119.    between the :DOOR_A and GOTO LOOP command lines.  These are entered in
  120.    place of the existing REM Place Program Name Here.  The following will 
  121.    briefly explain each of the commands which were set up within SF.BAT to 
  122.    run SFGILTRV as a SPITFIRE Door program:
  123.    
  124.       SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  125.    door.  It contains information about the user such as name and password.
  126.    SFGILTRV requires access to the information within SFDOORS.DAT.  Therefore,
  127.    before executing the program it must be copied to the directory in which
  128.    SFGILTRV is running.
  129.    
  130.       SFGILTRV is the program name and executes the game program from within
  131.    the door program.
  132.    
  133.       Once the user has terminated the game play of SFGILTRV, SPITFIRE
  134.    erases the SFDOORS.DAT file.
  135.    
  136.    
  137.    
  138.    SFGILTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  139.    ----------------------------------------------
  140.  
  141.       SPITFIRE has a sysop configurable command for the Main, Message and
  142.    File menus.  The sysop configurable command is executed through a
  143.    batch file which corresponds to the menu it is being run from.  In
  144.    other words, SFMAIN.BAT runs the sysop configurable command from
  145.    the Main Menu, SFMESS.BAT runs the one from the Message Menu and
  146.    SFFILE.BAT the one from the File Menu.  The commands necessary
  147.    to execute SFGILTRV can be set up in the batch file which corresponds
  148.    to the menu you wish to have SFGILTRV run from.
  149.  
  150.       The first thing you will need to establish is which of these menus
  151.    you wish to use to run SFGILTRV.  For this purpose, let's assume that
  152.    it is going to be set up so it can be run from the Main Menu.  (It
  153.    should be noted the set up procedure is the same regardless of which
  154.    Menu you are running SFGILTRV from.)
  155.  
  156.       Next, you will need to decide what you wish to name the command
  157.    option and establish what security level will be required for
  158.    users of your system to be able to access this option.  Once this
  159.    is determined you will need to modify the SFMAIN.MNU file using
  160.    your favorite text editor, as long as it saves in ASCII format.
  161.    (Refer to the SPITFIRE manual for further documentation on this
  162.    if needed.  It should also be noted that if SFGILTRV were being
  163.    set up to run from the File Menu, you would need to modify the
  164.    SFFILE.MNU file and if it was being set up to be run from the
  165.    Message Menu you would need to modify the SFMSG.MNU file.)
  166.  
  167.  
  168.       Examining the default SFMAIN.MNU file, you will notice the sysop
  169.    configurable command appears as:
  170.  
  171.         <K>............. Add Your Own,,1000,@
  172.  
  173.  
  174.       This will need to be replaced with a Command Character that will
  175.    be used to select the option from the menu.  It is ABSOLUTELY IMPERATIVE
  176.    that the Command Character must not duplicate an existing Command
  177.    Character for another menu option.  You will then need to include
  178.    a brief description of the Wildcat door program you are running, two
  179.    commas, the security level required to access this feature, and another
  180.    comma followed by the a @.  The @ must not be changed! (For more detailed
  181.    information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  182.    to your SPITFIRE manual.)
  183.     
  184.        <K>.... Brief Program Description,,10,@
  185.  
  186.       Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  187.    so that it can be executed from the Main Menu.  Do this using your
  188.    favorite text editor, as long as it saves in ASCII format.  (Again, it
  189.    should be noted that if SFGILTRV were being set up to run from the File
  190.    Menu, you would need to modify the SFFILE.BAT file and if it was being
  191.    set up to be run from the Message Menu you would need to modify the
  192.    SFMESS.BAT file.)
  193.  
  194.       Place the SFGILTRV.EXE file in the directory you wish to run the
  195.    program from.  SFGILTRV will create its own player score file,
  196.    SFGILTRV.TOP, if does not already exist.
  197.  
  198.       The commands set up in the SFMAIN.BAT file are very similar to
  199.    those used for executing the game through a door in the SF.BAT file.
  200.    For instance, if you were running SFGILTRV from the main SPITFIRE
  201.    directory your SFMAIN.BAT file might look like this:
  202.  
  203.        ECHO OFF
  204.        BRK OFF
  205.        SFGILTRV
  206.        BRK ON
  207.  
  208.       (BRK is not included in the SFGILTRV package because it is written
  209.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  210.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of 
  211.    other BBS systems.  BRK is not required to run SFGILTRV, however, it
  212.    is recommended since it will prevent a user using the CTRL BRK command 
  213.    to terminate the batch file, gaining access to your system at the 
  214.    DOS level.)
  215.  
  216.       If you wish to set SFGILTRV up in a separate subdirectory from
  217.    SPITFIRE, for instance, a subdirectory named SFGILTRV, your batch
  218.    file might look like this.
  219.  
  220.        ECHO OFF
  221.        BRK OFF
  222.        COPY SFMAIN.DAT \SF\SFGILTRV
  223.        CD \SF\SFGILTRV
  224.        SFGILTRV
  225.        ERASE SFMAIN.DAT
  226.        CD \SF
  227.        BRK ON
  228.  
  229.  
  230.       When SFGILTRV is executed, from either the door with the SF.BAT file
  231.    or from the sysop configurable command through a menu with the
  232.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  233.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  234.    SFDOORS.DAT file.  It will look for each of these files until it finds
  235.    it and the commands required for its execution.  If none of these
  236.    files are found, SFGILTRV will halt its execution.
  237.    
  238.  
  239.    DTE LOCK FEATURE
  240.    ----------------
  241.  
  242.       SFGILTRV automatically detects if the DTE is locked at 19200 baud.  If
  243.    SFGILTRV detects that the DTE is locked, then SFGILTRV opens the serial
  244.    port to the maximum baud rate of your system.  If SFGILTRV does not
  245.    detect that the DTE is locked, then the serial port is opened to the
  246.    baud rate of the caller.
  247.  
  248.    
  249.    SFGILTRV ON A MULTI-NODE SYSTEM
  250.    ------------------------------
  251.    
  252.       SFGILTRV is fully compatible for operation on a multi-node BBS.
  253.    It automatically handles any file locking and file sharing 
  254.    required during the doors execution.   
  255.  
  256.  
  257.    SYSOP FEATURES
  258.    --------------
  259.    
  260.        First, a status line is now displayed on the BBS monitor that 
  261.    provides information concerning the caller's name, baud rate of the 
  262.    caller and the security level of the caller.     
  263.    
  264.       A SFGILTRV.LMT file allows the sysop to establish a time limit for
  265.    door play according to the security level the caller has on the system.  
  266.    To modify the accompanying SFGILTRV.LMT file, use your favorite text
  267.    editor to represent the various security levels you have available on 
  268.    your system, a comma then the corresponding time you wish to allow for 
  269.    that particular security level in minutes.  For instance, it might 
  270.    look like this:
  271.    
  272.    10,15
  273.    25,20
  274.    50,25
  275.    999,30
  276.    
  277.    Each security level should begin a new line and you should have a
  278.    setting for each security level you have available on your system.
  279.    If you do not have a time limit set for a particular security 
  280.    SFGILTRV will default to the level 10 security level setting.
  281.    
  282.       Pressing the Shift Key and the F1 key simultaneously will 
  283.    terminate game play of SFGILTRV and return the caller back to the
  284.    BBS.  Pressing the Shift Key and the F9 key simultaneously will
  285.    terminate game play of SFGILTRV and log the caller off of the BBS.
  286.    If the Shift Key and the F9 key are pressed together, logging the
  287.    caller off the BBS, SPITFIRE will recycle and return to the
  288.    SPITFIRE Ready For Caller Prompt.   
  289.             
  290.  
  291.    SFGILTRV EXECUTION
  292.    ------------------
  293.       
  294.       When first executed, SFGILTRV will display a list of the Top Ten
  295.    high score players and the percentage of correct responses they achieved
  296.    while playing SFGILTRV.  Initially, this will be a dummy listing with
  297.    ten lines that display:
  298.    
  299.       0%...............YOUR NAME COULD BE HERE
  300.       
  301.    However, as the game is played, this will fill with the name of the
  302.    players, their percentage ratings and the date that the player was
  303.    added to the top ten listing.  
  304.    
  305.    NOTE: At least twenty questions must be attempted before SFGILTRV will
  306.          will figure the percentage rating for the player.
  307.          
  308.    To keep things interesting...the Sysop can erase the file which contains
  309.    the top ten listings SFGILTRV.TOP on a routine basis to give additional
  310.    players a chance to have their name added to the list.
  311.    
  312.    As the top ten list is displayed, at the bottom of the screen  is a
  313.    question which prompts the user whether they want to have ANSI Graphics
  314.    (y/n)? available to them during game play.  If the user responds with a
  315.    y (for yes) the game will display in color and if the user responds with
  316.    a n (for no) the game will display in monochrome.
  317.    
  318.    
  319.   
  320.    PLAYING SFGILTRV
  321.    ----------------
  322.   
  323.       Immediately after pressing any key (other than <Q> for Quit) from 
  324.    the Top Ten listing the game screen is displayed.  The screen will
  325.    look like the following:
  326.       
  327.    ------------------------------------------------------------------------
  328.  
  329.     ╔═════════════════════════════════════════════╗
  330.     ║   >>>>>>> GILLIGANS ISLAND TRIVIA <<<<<<<   ║
  331.     ║             GILLIGANS ISLAND                ║
  332.     ║       Trivia Game For SPITFIRE BBS Doors    ║
  333.     ║    The Catahoula Connection (601)799-2341   ║
  334.     ║ In Cooperation with Buffalo Creek Software  ║
  335.     ║     Copyright (C) by Jim Slade, 1991        ║
  336.     ║             UNREGISTERED VERSION!           ║
  337.     ╚═════════════════════════════════════════════╝
  338.        
  339.     RIGHT: 0                        WRONG: 0
  340.      
  341.     QUESTION:
  342.     The Gilligans Island Trivia Question is displayed
  343.     here.
  344.     
  345.     <1> Choice 1                        <2> Choice 2
  346.     <3> Choice 3                        <4> Choice 4
  347.     
  348.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  349.                        
  350.    -----------------------------------------------------------------------
  351.    
  352.    The first randomly chosen trivia question is selected from the data
  353.    file and is displayed to the screen. 
  354.    
  355.       The player makes his selection by entering the corresponding number.
  356.    As the game progresses, SFGILTRV will provide a running total of the
  357.    correct answers and also of the wrong answers the user has selected
  358.    during the game play.
  359.  
  360.    If the ten second timer should elapse before you respond, SFGILTRV
  361.    will count this as a wrong response and add an incorrect answer to 
  362.    the total WRONG answers obtained so far.
  363.            
  364.  
  365.    EXITING PLAY
  366.    ------------
  367.    
  368.       When you are ready to exit the game, simply select press "Q" for
  369.    <Q>uit.  If you qualify as one of the top ten players to date, 
  370.    SFGILTRV will congratulate you for becoming one of the top ten scorers
  371.    and add your name to the Top Ten listing.  You will once again see the 
  372.    Top Ten list displayed with your name added to the list.  
  373.    
  374.      If you exit the game before you have completed the twenty
  375.    questions required for eligibility to the Top Ten list or if you do not
  376.    qualify as a Top Ten player, the Top Ten listing will be displayed and 
  377.    you will be prompted to press any key to return to SPITFIRE.
  378.    
  379.    
  380.    DISTRIBUTION
  381.    ------------
  382.      
  383.       Please feel free to share SFGILTRV.ZIP with others.  However, it must
  384.    be distributed with SFGILTRV.EXE, SFGILTRV.DAT, SFGILTRV.TOP, SFGILTRV.LMT
  385.    and the SFGILTRV.DOC in the SFGILTRV.ZIP distribution package.  The
  386.    files must not be altered in any way or by any means.
  387.    
  388.          SFGILTRV.ZIP is distributed as Shareware software.  You are free to
  389.    try SFGILTRV, and if you find it to be a program you use please send the
  390.    required $10.00 fee to:
  391.    
  392.                              Jim Slade
  393.                              24371 Catahoula Lane
  394.                              Picayune, Ms. 39466
  395.                              
  396.    DISCLAIMER
  397.    ----------
  398.    
  399.       Jim Slade shall in no way be held responsible for any damage
  400.    incurred during the operation of SFGILTRV.EXE.  All responsibility lies
  401.    with the user of the software.   
  402.    
  403.  
  404.       Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  405.    225-8496 for his assistance.  Without his help this program would not
  406.    have been possible.   
  407.    
  408.  
  409.    SFGILTRV and other SPITFIRE programs are available for download from:
  410.    
  411.         Buffalo Creek BBS                    The Catahoula Connection
  412.         Sysop - Mike Woltz                      Sysop - Jim Slade
  413.           (515) 225-8496                         (601) 799-2341
  414.        19200/9600/2400/1200                       2400/1200/300
  415.  
  416.  
  417.  
  418.    Updates:
  419.    --------
  420.    
  421.    Version 2.5  Bug fixed which randomly terminated game play and returned 
  422.                 user to BBS.
  423.  
  424.    Version 3.0a  DTE lock feature is added.
  425.  
  426.                 Added the ability to set time limit for door play.
  427.  
  428.                 Added the ability for the sysop to use the Shift + F1 to
  429.                 return the user to the BBS and the Shift + F9 to log the
  430.                 user off the system.
  431.  
  432.                 Status line is added which displays on the BBS monitor
  433.                 that provides information on the user's name, security
  434.                 level and baud rate.
  435.                 
  436.    Version 3.5  The "/P" command line parameter is added allowing top
  437.                 score bulletins to be created in both Ansi (.CLR) and
  438.                 Non-Ansi (.BBS) format in the specified path using
  439.                 the specified file name.
  440.                 
  441.                 The bulletin file created and the .TOP file used to
  442.                 display the top scorers in SFGILTRV now also includes
  443.                 the date the player acquired the posted score.
  444.  
  445.    Version 4.0  Added file sharing and file locking capability so it
  446.                 is fully operational on a multi-node BBS system.
  447.  
  448.    Version 4.5  Added the /D command line parameter which allows the
  449.                 Sysop to configure the delay time in seconds that a
  450.                 user is allowed before the question times out.  Defaults
  451.                 to ten seconds if the /D command line parameter is not
  452.                 used.
  453.                 
  454.                 Added ASYNC routines for high speed modems with the
  455.                 16450 or 16550 UART chip.
  456.                 
  457.                 Requires usage of the SFGILTRV.REG file for registered
  458.                 versions of the SFGILTRV door game.
  459.  
  460.